home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Games Collection 1 / software vault.zip / software vault / CDR02 / LARN123.ZIP / LARN123.DOC < prev    next >
Text File  |  1991-09-10  |  19KB  |  440 lines
  1.  
  2.  
  3.                  PC LARN version 12.3 for IBM PC Compatibles
  4.                  -------------------------------------------
  5.  
  6.  
  7.      Table of contents
  8.      -----------------
  9.  
  10.  
  11.         1.  Introduction
  12.         2.  System requirements
  13.         3.  Files Supplied
  14.         4.  Installation
  15.         5.  Configuration
  16.         6.  Command line options
  17.         7.  TERMCAP
  18.         8.  WIZARD mode
  19.         9.  History and other Information
  20.  
  21.  
  22.  
  23.  
  24.      1. Introduction
  25.      ---------------
  26.  
  27.      LARN is a dungeon type adventure game similar in concept to HACK, ROGUE 
  28.      or MORIA, but with a different feel and winning criteria.  LARN was 
  29.      released for the UNIX environment in 1986 by Noah Morgan.  It was 
  30.      subsequently ported to the MS-DOS environment by Don Kneller.  Kevin 
  31.      Routley has been working on enhancements to LARN on and off for the
  32.      past two years.
  33.  
  34.  
  35.      2. System requirements
  36.      ----------------------
  37.  
  38.      PC LARN requires:
  39.  
  40.        - MS-DOS or PC-DOS 2.x or above.
  41.  
  42.        - at least 256K of RAM.
  43.  
  44.        - disk storage capacity of at least 360K, although twice that much is
  45.          preferred if you want to "checkpoint" your game to prevent
  46.          accidental lose due to a system failure.
  47.  
  48.        - the ANSI.SYS device driver must be installed (although the NANSI.SYS
  49.          driver is *strongly* preferred and has been included in this
  50.          distribution).  You should install either ANSI.SYS or NANSI.SYS, but
  51.          not both.  To install NANSI.SYS, put the line "device=NANSI.SYS" in
  52.          your CONFIG.SYS file.  See the TERMCAP section for further details.
  53.  
  54.  
  55.      3. Files supplied
  56.      -----------------
  57.  
  58.      The following files should be included in this LARN123.ZIP file:
  59.  
  60.        LARN123.DOC       This documentation.
  61.  
  62.        LARN123.FIX       Changes made between LARN V12.2 and V12.3.
  63.  
  64.        LARN123.EXE       The executable file.
  65.  
  66.        LARN.FTN          Fortune cookie messages.
  67.  
  68.        LARN.HLP          A help file, which can be read with the "?"
  69.                          command in LARN.
  70.  
  71.        LARN.MAZ          Some maze levels are pre-calculated and
  72.                          stored here.
  73.  
  74.        LARN.OPT          An example LARN.OPT file (see the CONFIGURATION
  75.                          section).
  76.  
  77.        TERMCAP           A file describing the escape sequences to send
  78.                          to the terminal.  The supplied TERMCAP file is
  79.                          for monochrome systems.  See the TERMCAP section
  80.                          for details on changing TERMCAP.
  81.  
  82.        NANSI.DOC         The documentation for NANSI.SYS.
  83.  
  84.        NANSI.SYS         A new ANSI.SYS that is *much* faster than
  85.                          ANSI.SYS and supports the line insert and line
  86.                          delete escape sequence that LARN uses.  This
  87.                          excellent product is written by Daniel Kegel.
  88.                          See the TERMCAP section and NANSI.DOC for more
  89.                          details.
  90.  
  91.  
  92.      4. Installation
  93.      ---------------
  94.  
  95.      NANSI.SYS or ANSI.SYS must be installed as a device driver on your 
  96.      system in order for LARN to work (see System Requirements above).
  97.  
  98.      For a hard disk system I suggest creating a \GAMES\LARN directory and
  99.      placing LARN and the provided support files in that directory.  Following
  100.      that, you would place \GAMES\LARN in your PATH.
  101.  
  102.      LARN will create several other files (LARN.SCR, LARN.PID, LARN.LOG)
  103.      in that directory.  Also, save files (LARN.SAV) and checkpoint files
  104.      (LARN.CKP) will go in there by default.  You will want to set the
  105.      'larndir:' option in your LARN.OPT file (see the Configuration section
  106.      below) to point to this directory.
  107.  
  108.      For two-floppy systems, I would suggest the following:
  109.  
  110.          o place LARN123.EXE, LARN.OPT and TERMCAP. on disk one.
  111.  
  112.          o place LARN.FTN, LARN.MAZ, and LARN.HLP on disk two.  This will
  113.            be the 'larndir:' disk (see the Configuration section below).
  114.            LARN.SCR, LARN.PID, LARN.LOG, save files, and checkpoint files
  115.            will go on this disk.
  116.  
  117.  
  118.      5. Configuration
  119.      ----------------
  120.  
  121.      PC LARN is configured by options placed in the file LARN.OPT.
  122.      When PC LARN starts up, it looks in the current directory for
  123.      this file, then in directories along your PATH.  Here are the
  124.      options that can be put in LARN.OPT.
  125.  
  126.      Options that are followed with a colon, ":", take at least one
  127.      argument.  Options without a colon are boolean, meaning you select
  128.      that option merely by mentioning it.
  129.  
  130.      Comments can be entered in the options file by using the '#'
  131.      character.
  132.  
  133.      These options are only in PC LARN:
  134.  
  135.        cursor:        start-line     end-line
  136.             Normally, LARN uses the standard DOS cursor (the flashing
  137.             underscore) to show where your player is located.  This can be
  138.             difficult to see.  This option results in a *BIOS* call to change
  139.             the cursor size.  For a monochrome display, the normal value of
  140.             start-line and end-line is 11 and 12.  Values of 4 and 9 give a
  141.             larger cursor which is not too obtrusive.
  142.  
  143.             If "cursor" is not specified, no BIOS call is made.
  144.  
  145.        DECRainbow
  146.             Put this in LARN.OPT if your computer is a DEC Rainbow and you
  147.             want to use graphics characters for drawing the maze.  You can
  148.             use any characters from the ASCII character set and from the
  149.             "line-drawing" character set.  To use line-drawing characters,
  150.             take the decimal value of the character and add 128 to it.  This
  151.             makes the values of line-drawing characters lie between decimal
  152.             128 and 255 and tells PC LARN you want a line-drawing character.
  153.  
  154.             Every attempt has been made with PC LARN V12.3 to maintain
  155.             DECRainbow compatibility as provided by Don Kneller.
  156.             Unfortunately, since I do not have access to a Rainbow, I cannot
  157.             make any guarentees.
  158.  
  159.        graphics:      wallc     floorc
  160.             In UNIX LARN, the wall character is a # and the floor character
  161.             is a blank (which makes it almost impossible to tell where you've
  162.             been).  In PC LARN, the default wall character is also a # but
  163.             the default floor character is a period.
  164.  
  165.             This option allows you to change these characters to something
  166.             you like.  Suggested characters are 176 (a graphic block) and
  167.             249 (a central dot).
  168.  
  169.             Almost all ASCII (non-graphics) characters already represent
  170.             objects in LARN, so you should only choose numbers that are
  171.             in the graphics character set (i.e. those with decimal values
  172.             greater than 128).
  173.  
  174.        keypad
  175.             This enables the keypad for use with LARN.  A *BIOS* call is used
  176.             to read the keypad.  The correspondance between keypad and game
  177.             command is:
  178.  
  179.                    Keypad                   Command
  180.                    7  8  9         u+l(y)    up(k)    u+r(u)
  181.                     \ | /                 \    |    /
  182.                    4 -5- 6        left(h)   nothing   right(l)
  183.                     / | \                 /    |    \
  184.                    1  2  3         d+l(b)    down(j)  d+r(n)
  185.                  Ins             inventory(i)
  186.  
  187.             The letter in () is the game command letter. "u+l" means up and
  188.             left.  The keypad "7" is translated to the command for moving one
  189.             space up and left.  With shift the commands are the same as the
  190.             uppercase letters.
  191.  
  192.        larndir:       directory
  193.             Sets "directory" to be the place LARN looks for files.  For hard
  194.             disks set this to be \GAMES\LARN.  For 2-floppy systems, use B:
  195.  
  196.             If "larndir" is not specified, the current directory is assumed.
  197.  
  198.        ramlevels:     number
  199.             This number is the maximum number of levels PC LARN will keep in
  200.             memory.  The number can be between 1 and 14.  Normally, PC LARN
  201.             will use as much memory as available, but you may want to use
  202.             less so there will be enough memory to start up a second copy of
  203.             COMMAND.COM with the LARN command `!'.  If there isn't enough
  204.             memory for COMMAND.COM, LARN will clear the screen and prompt
  205.             with "A>" until return is struck, then go back to the game.
  206.  
  207.             If "ramlevels" is not specified, a value of 14 is used.  If
  208.             "number" is less than 14, LARN will use a swapfile to store the
  209.             oldest levels.  Note that a level takes about 8K of memory.
  210.  
  211.        rawio
  212.             This option causes the input and output of your computer to be
  213.             switched to "raw" mode.  The advantage of this is faster output
  214.             and better handling of special characters ^S and ^P.
  215.  
  216.             ===========  WARNING ==========
  217.             Some computers (eg. DEC Rainbows) hang if rawio is attempted.
  218.             ==============================
  219.  
  220.        swapfile:      filename
  221.             This is the name of the swap file that will be used if ramlevels
  222.             is less than 14.  If all the levels fit in memory, no swap file
  223.             will be used.  You may want to put the swapfile on a RAMdisk.
  224.             If "swapfile" is not specified, LARN.SWP in directory larndir
  225.             will be used.
  226.  
  227.  
  228.  
  229.      The following are options usable with UNIX LARN as well:
  230.  
  231.        auto-pickup
  232.             Starts you out in 'automatic pickup' mode.  Whenever the player
  233.             moves onto an object, it will be picked up.  This mode can be
  234.             toggled with the '@' command while in the game.
  235.  
  236.        bold-objects
  237.             By specifying this option, all objects in the game will be
  238.             highlighted.  The 'highlight-objects' and 'inverse-objects'
  239.             specify which highlighting method will be used.
  240.  
  241.             The default is non-bold objects, except if the 'original-objects'
  242.             option is specified, when it is *forced* on (to distinguish
  243.             monsters and objects that are represented by the same
  244.             character).
  245.  
  246.        enable-checkpointing
  247.             With this option, the game is saved every 400 moves.  If your
  248.             system crashes it is possible to recover from the last checkpoint
  249.             file (LARN.CPK in the LARN directory) with the command "larn ++".
  250.  
  251.        highlight-objects
  252.             If the 'bold-objects' option is specified, this option causes
  253.             objects to be highlighted with bolding.
  254.  
  255.        inverse-objects
  256.             If the 'bold-objects' option is specified, this option causes
  257.             objects to be highlighted with inverse video.  The default is
  258.             'highlight-objects'.
  259.  
  260.        monster:       name
  261.             Sets the name of a monster.  If the name has a space in it,
  262.             enclose it in double quotes (eg "tooth fairy").  The leading
  263.             character determines which monster the name goes with (e.g.
  264.             "monster: bee" and "monster: Buzzbomb" change the names of
  265.             bugbears and Bats, respectively).
  266.  
  267.        name:          yourname
  268.             Sets the name of the player.  If you want a space in your name,
  269.             enclose it in double quotes (eg "Mad Max").
  270.  
  271.        no-introduction
  272.             Skip displaying the opening messages.
  273.  
  274.        no-beep
  275.             Disable sound from the speaker.
  276.  
  277.        original-objects
  278.             Like 'prompting' mode, this mode is provided for compatibility
  279.             with LARN V12.0.  By specifying this option, the characters
  280.             used to show objects in the game are the same as in 12.0.  The
  281.             default is to use characters that are closer to those used with
  282.             HACK, ROGUE and MORIA.
  283.  
  284.        prompt-on-objects
  285.             By specifying this option, you enable 'prompting' mode.  In this
  286.             mode, the player is prompted for the action to perform when
  287.             encountering an object (e.g. 'Eat, pick up, or ignore?').
  288.             Prompting mode is provided for compatibility with LARN V12.0, and
  289.             is off by default.
  290.  
  291.        savefile:      filename
  292.             The filename to use for saving the game.  The default is LARN.SAV
  293.             in the LARN directory.  For a 2-floppy system you might try
  294.             B:LARN.SAV if the LARN directory is on the A disk drive.
  295.  
  296.  
  297.      6. Command line options
  298.      -----------------------
  299.  
  300.      There are several command line options that can modify the behavior of
  301.      LARN.  These are:
  302.  
  303.        -o optionfile  Use this as the option file rather than LARN.OPT.  As
  304.                       with LARN.OPT, the current directory then directories
  305.                       along your path are searched for this file which
  306.                       supplies configuration information.
  307.  
  308.        -s             Show scores.
  309.  
  310.        -l             Show log file.  You have to know the Wizard's password
  311.                       to do this.
  312.  
  313.        -i             Show all scores including the inventories of dead
  314.                       players.
  315.  
  316.        -c             Create a new score file.  You have to know the Wizard's
  317.                       password to do this.  Erasing LARN.SCR has the same
  318.                       effect.
  319.  
  320.        -n             No welcoming message.  Prevents printing of the short
  321.                       introduction to LARN.  Putting the "no-introduction"
  322.                       configuration option in LARN.OPT has the same effect.
  323.  
  324.        -#             Where # is a number from 0 to 9.  This sets the
  325.                       difficulty of LARN to this level.  Normally, LARN
  326.                       starts out with difficulty 0 and increases in
  327.                       difficulty by 1 when you win at the current level.
  328.                       Thus the game automatically gets more difficult.
  329.  
  330.        -h, -?         A help screen that shows the command line arguments.
  331.  
  332.        -p             Prompt for actions on objects.  Specifying the
  333.                       'prompt-on-objects' option in LARN.OPT has the same
  334.                       affect.
  335.  
  336.        ++             Restore a game from a checkpoint file.  If you have
  337.                       checkpointing enabled (with the "enable-checkpointing"
  338.                       configuration option in LARN.OPT) then LARN writes a
  339.                       checkpoint file every 400 moves.  Should your system
  340.                       crash you can recover the game from the checkpoint file
  341.                       with this command line option
  342.  
  343.        For example:  "larn -n -o bobslarn.opt" starts up LARN with no
  344.        introductory message and uses bobslarn.opt file for configuration 
  345.        options.  "larn ++" tries to restore LARN from a checkpoint file.
  346.  
  347.  
  348.      7. TERMCAP
  349.      ----------
  350.  
  351.      LARN uses the UNIX "termcap" to select escape sequences to be sent to
  352.      the terminal driver (either ANSI.SYS or NANSI.SYS) to change video modes.
  353.      When LARN starts up, it checks in the environment for the variable called
  354.      "TERM".  The DOS command:
  355.        set TERM ibmpc-ega
  356.      will give the environment variable "TERM" the value "ibmpc-ega".  By
  357.      default, LARN assumes the value of TERM is "ibmpc-mono".
  358.  
  359.      Then LARN looks in the file called "TERMCAP" for a termininiefinition
  360.      with the same name as the value of TERM.  LARN first looks for TERMCAP in
  361.      the current directory, then in directory "\ETC" (the normal UNIX place),
  362.      then in directories along your PATH.
  363.  
  364.      The TERMCAP file uses 2 letter codes to describe each escape sequence
  365.      and \E to mean ESC (the escape character is decimal 27).  Each entry is
  366.      enclosed in colons.  For example, to start underscore mode on a monochrome
  367.      display, we want to send the sequence "ESC[4m".  This looks like
  368.      ":us=\E4m:" as a termcap entry.
  369.  
  370.      The following sequences are used by LARN:
  371.  
  372.        ti   terminal initialization.  You could have something like:
  373.                  :ti=\E44;37m:
  374.             which would mean to select blue background and white foreground.
  375.  
  376.        te   terminal end.  To reset your terminal to white on black:
  377.                  :te=\E0m:
  378.  
  379.        so   stand out.  Select red forground, keeping the blue background:
  380.                  :so=\E31m:
  381.  
  382.        se   standout end.  Back to white on blue:
  383.                  :se=\E44;37m:
  384.  
  385.        al   insert line.  This is *not* available in ANSI.SYS, so remove this
  386.             entry if you're using ANSI.
  387.  
  388.        dl   delete line.  This is *not* available in ANSI.SYS, so remove this
  389.             entry if you're using ANSI.
  390.  
  391.      If you want to make your own TERMCAP entry, copy the "ibmpc-mono"
  392.      entry, replace the name (eg use "ibmpc-color" or "ibmpc-ega" or whatever),
  393.      then replace the sequences with whatever you please.  The possible escape
  394.      sequences are generally listed in the DOS manual in the description of
  395.      ANSI.SYS, as well as in the NANSI.DOC file.
  396.  
  397.      Remember to change the environment variable "TERM" to reflect which
  398.      TERMCAP entry you want!  You should probably put a "set TERM=..." line in
  399.      your AUTOEXEC.BAT file.
  400.  
  401.  
  402.      8. WIZARD mode
  403.      --------------
  404.  
  405.      There is a WIZARD mode for testing features of the game.  To get into
  406.      WIZARD mode, type in an underscore "_" and answer the prompt for the
  407.      password with "pvnert(x)" (do not enter the quotes).  Wizards are 
  408.      non-scoring characters that get enlightenment, everlasting expanded 
  409.      awareness and one of every object in the game.
  410.  
  411.  
  412.      9. History and Other Information
  413.      --------------------------------
  414.  
  415.      Noah Morgan originally created LARN 12.0 and released the UNIX
  416.      version to the USENET in 1986.  Don Kneller ported the UNIX
  417.      version to MSDOS (both IBM PCs and DEC Rainbows).
  418.  
  419.      Kevin Routley has been working on LARN enhancements on and off for
  420.      the past two years.  Version 12.1 had a limited distribution.
  421.      Version 12.2 was distributed to the Usenet community.  Version 12.3
  422.      may be last version from Kevin that will maintain savefile compatibility 
  423.      with version 12.0 savefiles.  Some future version will be released 
  424.      as Shareware.
  425.  
  426.      Other editions of Larn have been distributed by others, namely
  427.      LARN13 and Ultra-Larn.
  428.  
  429.      I hope you enjoy this version of LARN.  Please send any questions,
  430.      suggestions, requests, or comments regarding LARN and LARN V12.3
  431.      in particular to:
  432.  
  433.                  Kevin Routley
  434.                  9 Aster Court
  435.                  Nashua, NH 03062
  436.                  ARPA:    routley@tle.dec.com
  437.                  BITNET:  routley@tle.dec.com
  438.  
  439.                  March 23, 1991
  440.